docs: Improve deprecation notices for GtkSettings
authorEmmanuele Bassi <ebassi@gnome.org>
Wed, 10 Jun 2015 16:16:41 +0000 (17:16 +0100)
committerEmmanuele Bassi <ebassi@gnome.org>
Thu, 11 Jun 2015 10:45:03 +0000 (11:45 +0100)
The button and menu item icons settings are deprecated; application
developers should control whether or not a widget should show an icon,
using the existing API.

https://bugzilla.gnome.org/show_bug.cgi?id=750718

gtk/gtksettings.c

index e754e8712ff3b61f640c0b7bacf8ed7d1261e41e..11f24e3b2eef6db017ff5766698457db83aa5842 100644 (file)
@@ -1316,7 +1316,11 @@ gtk_settings_class_init (GtkSettingsClass *class)
    *
    * Since: 2.4
    *
-   * Deprecated: 3.10: This setting is deprecated
+   * Deprecated: 3.10: This setting is deprecated. Application developers
+   *   control whether a button should show an icon or now, on a
+   *   per-button basis. If a #GtkButton should show an icon, use the
+   *   #GtkButton:always-show-image property of #GtkButton, and pack a
+   *   #GtkImage inside the #GtkButton
    */
   result = settings_install_property_parser (class,
                                              g_param_spec_boolean ("gtk-button-images",
@@ -1360,7 +1364,11 @@ gtk_settings_class_init (GtkSettingsClass *class)
    *
    * Whether images should be shown in menu items
    *
-   * Deprecated: 3.10: This setting is deprecated
+   * Deprecated: 3.10: This setting is deprecated. Application developers
+   *   control whether or not a #GtkMenuItem should have an icon or not,
+   *   on a per widget basis. Either use a #GtkMenuItem with a #GtkBox
+   *   containing a #GtkImage and a #GtkAccelLabel, or describe your menus
+   *   using a #GMenu XML description
    */
   result = settings_install_property_parser (class,
                                              g_param_spec_boolean ("gtk-menu-images",